home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / xlbiff.z / xlbiff / man / catn / xlbiff.n
Text File  |  1994-09-27  |  10KB  |  331 lines
  1.  
  2.  
  3.  
  4. XLBIFF(1)                USER COMMANDS            14 October 1991
  5.  
  6.  
  7.  
  8. NAME
  9.      xlbiff - mailbox message previewer for X
  10.  
  11. SYNOPSIS
  12.      xlbiff [ -_o_p_t_i_o_n ... ]
  13.  
  14. DESCRIPTION
  15.      The _x_l_b_i_f_f program lurks in the  background,  watching  your
  16.      mailbox  file,  waiting for new mail.  When mail arrives, it
  17.      invokes the MH _s_c_a_n(1) command and pops up a window with the
  18.      results.   Clicking  the  left mouse button anywhere in this
  19.      window makes it go away.  The window will also disappear  if
  20.      iconified or if the mailbox size drops to zero.
  21.  
  22. OPTIONS
  23.      _X_l_b_i_f_f accepts all of the standard X  Toolkit  command  line
  24.      options along with the additional options listed below:
  25.  
  26.      -help   This option indicates that a brief  summary  of  the
  27.              allowed  options  should be printed on standard out-
  28.              put.
  29.  
  30.      -bottom This option tells _x_l_b_i_f_f to realize/unrealize()  the
  31.              output window instead of using XtPopup/down().  This
  32.              has the effect of  causing  the  window  manager  to
  33.              reposition  the  window each time it pops up, and is
  34.              useful for when you specify negative Y  coordinates,
  35.              ie,  at the bottom of the screen.  Running _x_l_b_i_f_f in
  36.              this situation without -bottom would cause new lines
  37.              to run off the bottom edge of the screen.
  38.  
  39.      +bottom Opposite of -bottom.
  40.  
  41.      -file _f_i_l_e_n_a_m_e
  42.              This option specifies the name  of  the  file  which
  43.              should   be   monitored.   By  default,  it  watches
  44.              /usr/spool/mail/_u_s_e_r_n_a_m_e,  where  _u_s_e_r_n_a_m_e  is  your
  45.              login name.
  46.  
  47.      -rows _h_e_i_g_h_t
  48.              This option specifies the maximum height,  in  lines
  49.              of text, of the _x_l_b_i_f_f window.  The default is 20.
  50.  
  51.      -columns _w_i_d_t_h
  52.              This option specifies the maximum width, in  charac-
  53.              ters, of the _x_l_b_i_f_f window.  The default is 80.
  54.  
  55.      -resetSaver
  56.              If this option is set, _x_l_b_i_f_f will reset the  screen
  57.              saver  when  new  mail  comes in.  This is useful if
  58.              you're doing something near your workstation but not
  59.              on it.
  60.  
  61.  
  62.  
  63. ReadyPak                                                        1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XLBIFF(1)                USER COMMANDS            14 October 1991
  71.  
  72.  
  73.  
  74.      +resetSaver
  75.              Opposite of -resetSaver.
  76.  
  77.      -update _s_e_c_o_n_d_s
  78.              This option specifies the frequency  in  seconds  at
  79.              which _x_l_b_i_f_f should update its display.  The default
  80.              is 15 seconds.
  81.  
  82.      -fade _s_e_c_o_n_d_s
  83.              Number of seconds to wait before popping window back
  84.              down.   This option can be used to monitor events of
  85.              non-lasting  importance,  such  as  syslog  or  UUCP
  86.              queues.   The  default  value of 0 disables the fade
  87.              option.
  88.  
  89.      -led _l_e_d_N_u_m
  90.              This option specifies a keyboard  LED  to  light  up
  91.              when there is mail waiting in the _f_i_l_e.  The default
  92.              is zero (do not light a LED).
  93.  
  94.      -ledPopdown
  95.              This option indicates that the LED should be  turned
  96.              off  when xlbiff is popped down.  Ordinarily the LED
  97.              stays lit to remind  one  of  awaiting  mail.   This
  98.              option has no effect if the -led option is disabled.
  99.  
  100.      +ledPopdown
  101.              Opposite of -ledPopdown.
  102.  
  103.      -refresh _s_e_c_o_n_d_s
  104.              This option specifies the number of seconds to  wait
  105.              before  re-posting  the  mail  window after you ack-
  106.              nowledge it, and it still contains  the  same  mail.
  107.              The  default  is 0 (no refresh).  A useful value for
  108.              this is 1800 (30 minutes).
  109.  
  110.      -scanCommand _c_o_m_m_a_n_d
  111.              Specifies a shell command to be executed to list the
  112.              contents  of  mailbox  file.   The  specified string
  113.              value is used as the argument to  a  _s_y_s_t_e_m(3)  call
  114.              and  may  therefore  contain  i/o  redirection.  The
  115.              command's stdout is used  to  generate  the  window.
  116.              Internally, the command is generated as
  117.  
  118.                            sprintf(buf, scanCommand, file, columns)
  119.  
  120.              so a %s and %d respectively in scanCommand will gen-
  121.              erate  the  values of file and columns.  The default
  122.              scanCommand is
  123.  
  124.                        scan -file %s -width %d
  125.  
  126.  
  127.  
  128.  
  129. ReadyPak                                                        2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. XLBIFF(1)                USER COMMANDS            14 October 1991
  137.  
  138.  
  139.  
  140.      -checkCommand _c_o_m_m_a_n_d
  141.              Specifies a shell command to be  executed  to  check
  142.              for  new  mail (or some other condition) rather than
  143.              simply examining the size of  the  mail  file.   The
  144.              specified  string value is used as the argument to a
  145.              _s_y_s_t_e_m(3)  call  and  may  therefore   contain   i/o
  146.              redirection.   Like _x_b_i_f_f, an exit status of 0 indi-
  147.              cates that a  change  in  condition  demands  a  new
  148.              evaluation  of  scanCommand  and subsequent popup, 1
  149.              indicates no change in status and 2  indicates  that
  150.              the condition has been cleared and the _x_l_b_i_f_f window
  151.              should pop down.  By default, no  shell  command  is
  152.              provided.
  153.  
  154.              This option may be  useful  to  monitor  logins  (by
  155.              checking  update times of /etc/utmp), using POP, and
  156.              so forth.  Let your imagination go wild!
  157.  
  158.      -volume _p_e_r_c_e_n_t_a_g_e
  159.              This option specifies how loud the  bell  should  be
  160.              rung when new mail comes in.
  161.  
  162.      The following standard X Toolkit command line arguments  are
  163.      commonly used with _x_l_b_i_f_f:
  164.  
  165.      -display _d_i_s_p_l_a_y
  166.              This option specifies the X server to contact.
  167.  
  168.      -geometry +_x+_y
  169.              This option specifies the preferred position of  the
  170.              scan window.
  171.  
  172.      -bg _c_o_l_o_r
  173.              This option specifies the color to use for the back-
  174.              ground of the window.
  175.  
  176.      -fg _c_o_l_o_r
  177.              This option specifies the color to use for the fore-
  178.              ground of the window.
  179.  
  180.      -xrm _r_e_s_o_u_r_c_e_s_t_r_i_n_g
  181.              This option specifies a resource string to be  used.
  182.              This is especially useful for setting resources that
  183.              do not have separate command line options.
  184.  
  185. RESOURCES
  186.      The application class name is XLbiff.  It understands all of
  187.      the core resource names and classes as well as:
  188.  
  189.      bottom (class Bottom)
  190.              Same as the -bottom option.
  191.  
  192.  
  193.  
  194.  
  195. ReadyPak                                                        3
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. XLBIFF(1)                USER COMMANDS            14 October 1991
  203.  
  204.  
  205.  
  206.      file (class File)
  207.              Same as the -file option.
  208.  
  209.      scanCommand (class ScanCommand)
  210.              Same as the -scanCommand option.
  211.  
  212.      checkCommand (class CheckCommand)
  213.              Same as the -checkCommand option.
  214.  
  215.      resetSaver (class ResetSaver)
  216.              Same as the -resetSaver option.
  217.  
  218.      update (class Interval)
  219.              Same as the -update option.
  220.  
  221.      fade (class Fade)
  222.              Same as the -fade option.
  223.  
  224.      columns (class Columns)
  225.              Same as the -columns option.
  226.  
  227.      rows (class Rows)
  228.              Specifies the  maximum  height,  in  lines,  of  the
  229.              _x_l_b_i_f_f window.  The default is 20.
  230.  
  231.      led (class Led)
  232.              Same as the -led option.
  233.  
  234.      ledPopdown (class LedPopdown)
  235.              Same as the -ledPopdown option.
  236.  
  237.      refresh (class Refresh)
  238.              Same as the -refresh option.
  239.  
  240.      sound (class Sound)
  241.              Specify a command to be run in place of a bell  when
  242.              new  mail  arrives.  For example, on a Sun Sparc you
  243.              might use:
  244.  
  245.               *sound: /usr/demo/SOUND/play -v %d /usr/demo/SOUND/sounds/doorbell.au
  246.  
  247.              The command is generated internally with sprintf, so
  248.              the  characters  ``%d''  will  be  replaced with the
  249.              numeric value of the volume resource.
  250.  
  251.      volume (class Volume)
  252.              Same as the -volume option.
  253.  
  254. ACTIONS
  255.      _X_l_b_i_f_f provides the  following  actions  for  use  in  event
  256.      translations:
  257.  
  258.  
  259.  
  260.  
  261. ReadyPak                                                        4
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. XLBIFF(1)                USER COMMANDS            14 October 1991
  269.  
  270.  
  271.  
  272.      popdown()
  273.              This action causes the window to vanish.
  274.  
  275.      exit()  This action causes _x_l_b_i_f_f to exit.
  276.  
  277.      The default translations are
  278.  
  279.              <Button1Press>:  popdown()
  280.              <Button3Press>:  exit()
  281.  
  282.  
  283. ENVIRONMENT
  284.      DISPLAY is used to get the default host and display number.
  285.  
  286. FILES
  287.      /usr/spool/mail/_u_s_e_r_n_a_m_e
  288.              default mail file to check.
  289.  
  290. SEE ALSO
  291.      _X(1), _s_c_a_n(1)
  292.  
  293. BUGS
  294.      specifying dimensions in -geometry causes badness.
  295.  
  296.      The led option does not work on Suns before SunOS 4.1/X11R5.
  297.  
  298. AUTHOR
  299.      Ed Santiago, esm@auspex.com
  300.  
  301. ACKNOWLEDGEMENTS
  302.      _X_l_b_i_f_f took shape around the xgoodbye sample program in  the
  303.      O'Reilly  _X _T_o_o_l_k_i_t _I_n_t_r_i_n_s_i_c_s _P_r_o_g_r_a_m_m_i_n_g _M_a_n_u_a_l.  A lot of
  304.      code was stolen from xbiff, including this man page.  Thanks
  305.      also  to  Stephen  Gildea  (gildea@expo.lcs.mit.edu) for the
  306.      many, many contributions that made _x_l_b_i_f_f grow from  a  mid-
  307.      night hack to a more mature product.
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327. ReadyPak                                                        5
  328.  
  329.  
  330.  
  331.